-
Notifications
You must be signed in to change notification settings - Fork 6
[DIT-11792][DIT-11791][DIT-11960] IOS Strings Dict, Android, ICU format additions #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DIT-11792][DIT-11791][DIT-11960] IOS Strings Dict, Android, ICU format additions #130
Conversation
…d amongst all export formats. Updated IOSStringsDict to use that class
…s to no longer include baseExport method tests. Updated all formats to test for correct output file creation
…enerics to BaseFormatter to allow for parameter-ized response types
| const textItemsMap = await this.fetchTextItemsMap(); | ||
| const componentsMap = await this.fetchComponentsMap(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about fetching in parallel to speed this up?
| const textItemsMap = await this.fetchTextItemsMap(); | |
| const componentsMap = await this.fetchComponentsMap(); | |
| const [textItemsMap, componentsMap] = await Promise.all([ | |
| this.fetchTextItemsMap(), | |
| this.fetchComponentsMap(), | |
| ]); |
| }), | ||
| format: this.exportFormat, | ||
| }; | ||
| const textItemsFileContent = await fetchText<TTextItemsResponse>( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we parallelize this one as well by pushing to a promises array and awaiting them all at once?
| }), | ||
| format: this.exportFormat, | ||
| }; | ||
| const componentsFileContent = await fetchComponents<TComponentsResponse>( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as text items -- Can we parallelize this one as well by pushing to a promises array and awaiting them all at once?
joustrich
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple suggestions to parallelize the data fetching, but otherwise looks good!
* [DIT-11970] iOS Strings Format Support (#129) * Add scaffolding for ios-strings support, notably IOSStringsFormatter class, and IOSStringsOutput file * Add /v2/variants endpoint. Update IOSStringsFormatter to pull down variants and projects as expected. Moved shared BaseFormatter class methods out of JSON and IOSStringsFormatters * Minor inline doc updates * Add pull command E2E tests for outputted ios-strings files. Added component mapping to iosStringsFormatter * Add unit tests to IOSSTringsFormatter class * Update variant fetching to be shared across textItems and components. Unit tests additions to IOSStringsFormatter class * Update http request tests to handle default error * Minor: test fix * Minor: cleanup and .gitignore of local items * [DIT-11792][DIT-11791][DIT-11960] IOS Strings Dict, Android, ICU format additions (#130) * Add ios-stringsdict support to BaseFormatter * Refactor IOSStringsFileFormatter into BaseExportFormatter to be shared amongst all export formats. Updated IOSStringsDict to use that class * Add android export format * Add BaseExportFormatter class tests. Updated IOSStringsFormatter tests to no longer include baseExport method tests. Updated all formats to test for correct output file creation * Update base generateQueryParams to take in filters as sole param * Add i18n test cases * Add ios-stringsdict and Android XML formatting tests to pull * Add ICU format. Update HTTP Response types to allow for JSON. Added generics to BaseFormatter to allow for parameter-ized response types * Updated ExportComponentsResponse and TextItemsResponse Zod schema * Made BaseExportFormatter abstract class * Minor: clean * Test fix and HTTP wrapper cleanup * Minor: clean * Add promise.all to fetchTextItemsMap and fetchComponentsMap for performance * [DIT-12000] Add iosLocales Configuration Support (#132) * Add iosLocale to config and file generation * Add new fetch request for swift file from API * Add Swift file generation logic to baseexport class * clean for PR * Add test cases to ios methods on baseExport class * Minor: clean * minor: remove unused type * minor: remove test script * update pull params for export endpoints * Update all instances of 'icu' to be 'json_icu' * Address initial PR comments * Add swift file generation to root of pull command. Address some cleanup review comments * Fix pull command tests for iosLocales * Move generateSwiftFile tests to util file * Minor clean * Remove console log and fix test data * Add test case for empty iosLocalese array * Minor name clarification * Fix format default case, missing promise.all, and typing issue * Added ios-specific getLocalesPath method to those classes, along with tests * Fix issue where ___<variant_id> suffixed files were getting written to iosLocale directories * Split up textItems and components HTTP calls for export vs default * Replaced all instances of 'base' with BASE_VARIANT_ID const in lib/src directory. Removed now-unnecessary type params from Formatter classes * Fix text item text status duplicates from merge. Bump version minor * Fix status filter merge issue * Fix to base variant not getting included in variants (id: all). minor cleanup of statuses qp * Add fetchVariants tests
Overview
Updated all
/v2/{textItems | components}/exportformats (ios, android, icu) to use a sharedBaseExportFormatterabstract class that's the bulk logic for this PR. This was mostly pulled over from the originalios-stringsimplementation and made a bit more format-agnostic for the rest of the use cases.Added format classes and their respective output configs and what not:
IOS
.stringsdictAndroid
.xmlICU
.jsonUpdated base formatter class's
generateQueryParamsfunction to be less awkwardFixed my old weird HTTP wrapper thing
Context
DIT-11971: [CLI] ICU Format
DIT-11972: [CLI] IOS Strings Dict Format
DIT-11960: [CLI] Android Format
Test Plan
Setup:
I like this config.yml file, it puts everything in one directory and lets you check by format. Just replace the projects and variants configured here with a couple of your local projects/variants that you use regularly. Make sure they have some variables and variant usage in both text items and components that you can test.